Skip to content

Fix incorrect filename references in Kubernetes documentation#281

Merged
sfroment merged 2 commits intodev/giwook-Han/sequencer-failoverfrom
copilot/sub-pr-271
Dec 3, 2025
Merged

Fix incorrect filename references in Kubernetes documentation#281
sfroment merged 2 commits intodev/giwook-Han/sequencer-failoverfrom
copilot/sub-pr-271

Conversation

Copy link
Contributor

Copilot AI commented Dec 3, 2025

Why is this change necessary?

Documentation referenced deploy.sequencer.yaml at multiple locations, but the actual file is named stateful.sequencer.yaml, causing broken commands and confusion for users following the guide.

Description

Updated all 7 references in docs/k8s.md:

  • Manifest description (line 22)
  • Environment variable source reference (line 38)
  • Init container script location (line 57)
  • Prebuilt image reference in Option A (line 94)
  • Manual edit instructions in Option 1 (line 118)
  • kubectl apply command (line 144)
  • StorageClass configuration note (line 154)

All references now correctly point to k8s/stateful.sequencer.yaml to match the actual file in the repository.

Closes #271

Type of change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Other (please describe):

Checklist

  • I have tested my changes
  • I have updated documentation if needed
  • I have reviewed my code for best practices

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: sfroment <7238385+sfroment@users.noreply.github.com>
Copilot AI changed the title [WIP] Update leader election implementation based on review feedback Fix incorrect filename references in Kubernetes documentation Dec 3, 2025
Copilot AI requested a review from sfroment December 3, 2025 09:26
@sfroment sfroment marked this pull request as ready for review December 3, 2025 09:33
@sfroment sfroment requested a review from Giwook-Han as a code owner December 3, 2025 09:33
Copilot AI review requested due to automatic review settings December 3, 2025 09:33
@sfroment sfroment merged commit 78d5276 into dev/giwook-Han/sequencer-failover Dec 3, 2025
@sfroment sfroment deleted the copilot/sub-pr-271 branch December 3, 2025 09:33
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes broken documentation by correcting all filename references from the non-existent deploy.sequencer.yaml to the actual file stateful.sequencer.yaml in the Kubernetes guide, resolving confusion and command failures for users.

  • Updated 7 filename references throughout the Kubernetes documentation
  • Ensured consistency across manifest descriptions, configuration instructions, and command examples

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

sfroment added a commit that referenced this pull request Dec 3, 2025
* init: add k8s yaml

* feat: add k8s leader election logic

* add: k8s yamls

* mod: add k8s leader shutdown

* add: k8s node yaml

* fix: use pv&pvc to maintain status on k8s

* chore: yaml && add docs

* feat: mod batch producer load batch number when it starts (#272)

* fix: cargo.toml

* chore: toml

* mod: k8s + ovh

* chore: lint

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* chore: fix here we have 2 result imbricated

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* chore: change a bit

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* feat: add node deploy

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* chore: fix potential race

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* chore: update docs

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* chore: use anyhow error

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* refactor: change the way the main is started" (#275)

* chore: add health check

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* refactor: change the way the main is started

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* chore: nitpick

* mod: k8s yaml

* chore: remove  command in justfile

* chore: fix just sequencer & node , fix kill process in start.sh

* chore: rm

* refactor: coordination k8s (#276)

* refactor: coordination k8s

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* chore: save

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* chore: keep health alive

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* fix: start

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* Apply suggestion from @Copilot

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* chore: remove useless

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* chore: review comment

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* chore: add back save on shutdown

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

---------

Signed-off-by: Sacha Froment <sfroment42@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update justfile

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update cmd/sequencer/src/main.rs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update cmd/sequencer/src/cli.rs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update cmd/node/src/cli.rs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update cmd/sequencer/src/cli.rs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update justfile

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* chore: fix 1st call

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* Refactor: Use idiomatic assert! in CLI tests (#277)

* Initial plan

* Replace if-panic patterns with assert! in CLI tests

Co-authored-by: sfroment <7238385+sfroment@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: sfroment <7238385+sfroment@users.noreply.github.com>

* Fix missing assert in CLI test for command parsing (#278)

* Initial plan

* Fix matches! macro usage in sequencer CLI tests

Added assert! around matches! calls in parse_stop_and_get_pub_key test
to properly verify command types instead of just evaluating the boolean.

Co-authored-by: sfroment <7238385+sfroment@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: sfroment <7238385+sfroment@users.noreply.github.com>

---------

Signed-off-by: Sacha Froment <sfroment42@gmail.com>
Co-authored-by: Giwook-Han <hkw00011@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: sfroment <7238385+sfroment@users.noreply.github.com>

* chore: lint

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* chore: lint

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* chore: fix registry

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

* Update docs/k8s.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update docs/k8s.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Fix StatefulSet name references in k8s documentation (#283)

* Initial plan

* Fix StatefulSet name references in k8s documentation

Co-authored-by: sfroment <7238385+sfroment@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: sfroment <7238385+sfroment@users.noreply.github.com>

* Fix documentation references to use correct StatefulSet manifest filename (#282)

* Initial plan

* Fix documentation: update references from deploy.sequencer.yaml to stateful.sequencer.yaml

Co-authored-by: sfroment <7238385+sfroment@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: sfroment <7238385+sfroment@users.noreply.github.com>

* Fix incorrect filename references in Kubernetes documentation (#281)

* Initial plan

* Fix all references from deploy.sequencer.yaml to stateful.sequencer.yaml

Co-authored-by: sfroment <7238385+sfroment@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: sfroment <7238385+sfroment@users.noreply.github.com>

* Consolidate shutdown logic in K8s leader election error handling (#284)

* Initial plan

* Call shutdown() on error paths to ensure consistent cleanup

Co-authored-by: sfroment <7238385+sfroment@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: sfroment <7238385+sfroment@users.noreply.github.com>

* fix: healt.port

Signed-off-by: Sacha Froment <sfroment42@gmail.com>

---------

Signed-off-by: Sacha Froment <sfroment42@gmail.com>
Co-authored-by: Sacha Froment <sfroment42@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: sfroment <7238385+sfroment@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants